PUT Order

When an order is created in the LetsGetChecked system, it is immediately set for dispatch by our team. In most cases, an order is dispatched within one business day of order creation.

Order operations are created to manage the client/customer purchases with LetsGetChecked. The operation is idempotent. If the response of the operation is not obtained, for example if the connection breaks, the client application can retry. If the previous invocation never arrived it runs for the first time, and if it runs, the previous result is returned.

Request

Endpoint

PUT {clientId}/api/v1/orders/{clientOrderId}

Create a unique order for a specific client.

Headers

The PUT Order API requires the following information in the headers of an HTTP request:

HTTP Header	Description
Authorization	The HTTP Authorization request header contains the credentials to authenticate a user agent with a server.
Accept	The HTTP Accept request header contains information about the content types, expressed as MIME types, that the client can understand. The MIME type for the PUT Order API request is application/json.
Content-Type	The Content-Type request header defines the type of data that the client sends to the server. For the PUT Order API request, the type of data is application/json.

Path parameters

Parameter	Description	Type	Required/Optional
clientId	The clientId is a unique code that LetsGetChecked provides. The clientId is used to identify a client, when a client calls the Orders and Results APIs. The code is formed by 1 to 4 alphanumeric characters. The clientId displays in the HL7 results as PV1.3.1.	string	Required
clientOrderId	The clientOrderId is a unique ID, per order, in the client's system. The maximum length is 100 characters. When a client application uses the Order API, a clientOrderId value is generated by the client that is the reference for the order in the LetsGetChecked system. The Client Order ID displays in the HL7 results as an AOE OBX segment.	string	Required

Sample request

{
   "address":{
      "addressLine1":"Line1",
      "addressLine2":"Line2",
      "city":"Boston",
      "countryIsoAlpha2":"US",
      "postalCode":"55555",
      "state":"AL"
   },
   "patientInfo":{
      "participantId":"11111",
      "firstName":"fName",
      "middleName":"mName",
      "lastName":"lName",
      "email":"test@email.com",
      "phoneNumber":{
         "phoneCountryCode":"+1",
         "phoneNumber":"555588888"
      },
      "gender":"Male",
      "dob":"2000-01-01",
      "ethnicity":"Hispanic",
      "race":"UnknownRace",
      "participantLanguage":"ENGLISH",
      "healthPlanName":"payerPlanName"
   },
   "clientSubCode":"01",
   "clientLocationEventId":"01",
   "diagnosisCodes":[
      "D01"
   ],
   "programCode":"Health4All",
   "primaryCareProvider":{
      "id":"PCP1234567",
      "firstName":"test",
      "middleName":"middle",
      "lastName":"last",
      "address":{
         "addressLine1":"Adelphi House",
         "addressLine2":"Dún Laoghaire",
         "city":"Dublin",
         "countryIsoAlpha2":"IR",
         "postalCode":"A96 YC63"
      },
      "phone":"965878945",
      "phone2":"123456789",
      "fax":"8181818181",
      "vendorName":"vendorName"
   },
   "questionnaireInfo":{
      "gender":"female",
      "countryIsoAlpha2":"US",
      "testKitCode":"TKCODE",
      "answers":[
         {
            "questionId":"fc422870-41a5-488a-bef7-9c3db6f622a4",
            "selections":[
               {
                  "choiceIndex":1,
                  "answerValue":"No, I have never smoked regularly"
               }
            ]
         }
      ]
   },
   "customData":[
      {
         "key":"SubscriberID",
         "value":"12345678"
      },
      {
         "key":"key2",
         "value":"value2"
      },
      {
         "key":"key3",
         "value":"value3"
      }
   ],
   "physicianInfo":{
      "firstName":"PhysicianFirstName",
      "middleName":"MiddleName",
      "lastName":"PhysicianLastName",
      "npi":1000000001
   }
}

Request definitions

The following table describes each item in the body of the request:

Element	Description	Type	Required/Optional
address	The user’s address based on the address in the request.	object(Address)	Required
address /addressLine1	The first line of the user’s address. This can have a maximum length of 35 characters.	string	Required
address /addressLine2	The second line of the user’s address. This can have a maximum length of 35 characters.	string	Optional
address /city	The user’s city.	string	Required
address /countryIsoAlpha2	The user’s country. Must be the ISO-3166 standard compliant. Allowed value: US	string	Required
address /postalCode	The user’s postal code or zip code.	string	Required
address /state	The user’s state. Allowed values: AK, AL, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY	string	Required
PatientInfo	Information about the patient.	object(PatientInfo)	Required
PatientInfo /participantId	The Participant ID must be unique and associated with a person in your system of record. It can be an employee ID or Customer ID. Do not reuse or recycle Participant IDs.	string	Required
PatientInfo /firstName	The patient’s first name.	string	Required
PatientInfo /middleName	The patient’s middle name.	string	Optional
PatientInfo /lastName	The patient’s last name.	string	Required
PatientInfo/ /email	The patient’s email address.	string	Optional
PatientInfo /phoneNumber	The patient’s phone number.	string	Required
PatientInfo/participantId/PhoneNumber /phoneCountryCode	The country code of the user’s phone number. Format: The value should start with a "+" followed by one to four numeric digits.	string	Required
PatientInfo/participantId/PhoneNumber /phoneNumber	The remaining digits of the user’s phone number, after the country code.	string	Required
PatientInfo /gender	The patient’s gender. The following case agnostic values are allowed: MALE, Male, male FEMALE, Female, female	string	Required
PatientInfo /dob	The patient’s date of birth. The format is YYYY-MM-DD.	string	Required
PatientInfo /ethnicity	The patient’s ethnicity. The following values are allowed: NoEthnicityProvided Hispanic NotHispanic	string	Required
PatientInfo /race	The patient’s race. The following values are allowed: UnknownRace, AmericanIndian, NativeAlaskan, Asian, AfricanAmerican, African, Hispanic, Latino, PacificIslander, NativeHawaiian, Caucasian, AshkenaziOrSephardiJewish, OtherRace	string	Required
PatientInfo /participantLanguage	The patient’s language. The following case agnostic values are allowed: ENGLISH, English, english SPANISH, Spanish, spanish	string	Optional
PatientInfo /healthPlanName	The sub-plan name for the current payer.	string	Optional
programCode	The code associated with the program, that is provided by LetsGetChecked.	string	Required
primaryCareProvider	The patient Primary Care Provider (PCP) information.	object(PrimaryCareProvider)	Optional
primaryCareProvider /id	The PCP unique identicator Empty is allowed (indicates that there is no provider for the patient) Alphanumeric is allowed Maximum length of 15 characters	string	Required
primaryCareProvider /firstName	The PCP's first name. Tip: Together, the first, middle, and last names combined should have less than 100 characters.	string	Required
primaryCareProvider /middleName	The PCP's middle name. Tip: Together, the first, middle, and last names combined should have less than 100 characters.	string	Optional
primaryCareProvider /lastName	The PCP's last name. Tip: Together, the first, middle, and last names combined should have less than 100 characters.	string	Required
primaryCareProvider /phone	The PCP's phone number.	string	Optional
primaryCareProvider /phone2	The PCP's secondary phone number.	string	Optional
primaryCareProvider /fax	The PCP's fax number.	string	Optional
primaryCareProvider /vendorName	The PCP vendor provider name.	string	Optional
primaryCareProvider /address	The PCP's address.	object(Address)	Required
QuestionnaireInfo	The LetsGetChecked questionnaire for a test kit. The questionnaire is an optional feature of the Orders API where you can view questions and answers associated with a test kit. For more information, see GET Questionnaire.	object(QuestionnaireInfo)	Optional
QuestionnaireInfo /gender	The gender of the person completing the questionnaire.	string	Required
QuestionnaireInfo /countryIsoAlpha2	The country where the person is located, who is completing the questionnaire.	string	Required
QuestionnaireInfo/testKitCode	The code for the test kit.	string	Required
QuestionnaireInfo/answers	The LetsGetChecked answers for a questionnaire.	Array of object(Answer)	Required
customData	Contains any additional custom data that is associated with an order and it is available for reporting purposes. Custom data must be in the format of key-value pairs. Alphanumeric characters are allowed. Maximum length of 50 characters. Key and value cannot be null. Use cases for customData Sending appointment times so that LetsGetChecked can ship orders based on appointment dates. Adding extra information to an order such as a patient's location or the name of the clinic they visit. Customers can then use filters on reports for the order, for example, to categorize a patient by city or clinic.	List of key-value pairs	Optional
note	Contains any additional notes or information.	string	Optional
PhysicianInfo	The physician information. You can use this object to submit physician information for a physician that does not order from LetsGetChecked. Note: The PhysicianInfo information is mandatory when the physician is not a LetsGetChecked physician.	object(PhysicianInfo)	Optional
PhysicianInfo /firstName	The first name of the physician.	string	Required
PhysicianInfo /middleName	The middle name of the physician.	string	Optional
PhysicianInfo /lastName	The last name of the physician.	string	Required
PhysicianInfo /npi	The National Provider Identifier (NPI) for the physician.	integer	Required
answers	The LetsGetChecked answers for a questionnaire for a test kit.	object(answers)	Optional
answers /questionId	Unique ID of the answer.	Guid QuestionId	Required
answers /selections	Array of the selected answer choices for the answers.	Array of object(selections)	Required
selections	The LetsGetChecked selection choices for an answer for a questionnaire for a test kit.	object(selections)	Optional
selections /choiceIndex	Index of the choice chosen.	integer	Required
selections /answerValue	Value of the answer.	string	Required
selections /supportingFieldValue	Supporting value associated with the answer.	string	Optional
clientSubCode	This code can be associated with a particular testing initiative, program, client organizational entity, building, or location.	string	Optional
clientLocationEventId	This code can be associated with a particular location for shipping supplies and reporting.	string	Optional
diagnosisCodes	The diagnosis code. It displays in the HL7 results as one DG1 segment per code.	Array of string	Optional

Response

The sample response is a single JSON object that contains the following fields:

Property	Description	Type
clientOrderId	The clientOrderId is a unique ID, per order, in the client's system. The maximum length is 100 characters. When a client application uses the Order API, a clientOrderId value is generated by the client that is the reference for the order in the LetsGetChecked system.	string
participantId	The participantId must be unique and associated with someone in your system of record. It can be an employee ID or Customer ID. Do not reuse or recycle participant IDs.	string
lgcOrderRef	The unique LetsGetChecked order reference for the original order in the LetsGetChecked system.	Guid

Sample response

{
"clientOrderId":"1234567",
"participantId":"11111",
"lgcOrderRef":"e392d458-f31e-40fb-b7a5-ee3a9ba71fdc"
}